Chapter 4-8: Runtime Subroutine's and Predefined Processes

.TEXT FROM UNICODE

This subroutine transcodes a Unicode alpha field into a RAW alpha field.

Usage:

Description:

This subroutine will transcode a Unicode alpha field to a RAW alpha field with error handling for the characters that cannot be transcoded. The first 2 parameters are required. If any required parameters are missing, the subroutine will CANCEL.

<raw> is the RAW alpha field to contain the transcoded string (Required). This must be PASSed with Share "Y" to return the value. This must be a RAW field type, otherwise the transcoding will fail.

<unicode_source> is the field containing the Unicode string to be transcoded (Required).

<encoding> is the encoding to use in the RAW target field. If not specified or a blank is PASSed, it will check the environment variable APPX_RAW_ENCODING and use that encoding. If that is not present, it will default to ISO-8859-15.

<action> is the action to be taken if a character cannot be transcoded to RAW (Optional). If not PASSed or blank is PASSed, defaults to SKIP.

• SKIP - skip the offending character, it will not be transcoded to the target field but the remaining characters will be.
• STOP - stop transcoding and return an error
• SUBS - Substitute the character in the <option> field for the offending character
• ESCAPE - Escape the character according to the convention specified in the <option> field

<option> contains either the substitute character to use if <action> is SUBS or the convention to use if <action> is ESCAPE. This is required if <action> is SUBS or ESCAPE. If <action> is SUBS you may pass any single character that exists in the target encoding. If more than one character is PASSed, only the first character is used. If <action> is ESCAPE, then PASS one of the following:

• C - specifies C style escaping (\uXXXX or \UXXXXXXXX)
• STYLE - specifies CSS2 escaping (\XXXXXX)
• JAVA - specifies Java escaping (\uXXXX)
• UNICODE - specifies Unicode escaping {U+XXXXX}
• DECIMAL - - specifies XML decimal escaping ($#XXXX)
• X - specifies XML hex escaping (&#xXXXX)

<error text> if an error occured this field contains additional error text from the Unicode library (Optional). This must be PASSed with Share "Y" to return the value.

Application Design Manual                                         "Powered by Appx Software"

1702

©2006-2023 By APPX Software, Inc. All Rights Reserved